Obtains the control handle for a dialog item in an embedding hierarchy.

OSErr GetDialogItemAsControl (
    DialogPtr inDialog, 
    SInt16 inItemNo, 
    ControlHandle *outControl
);

inDialog

A pointer to the dialog box to examine.

inItemNo

The position of an item in the dialog box’s item list.

outControl

A pointer to a control handle that, on return, refers to the embedded control.

function result

A result code. The Control Manager result code errItemNotControl indicates that the specified dialog item is not a control.

DISCUSSION

When an embedding hierarchy is established, GetDialogItemAsControl produces a handle to the embedded controls (except Help items). It should be used instead of GetDialogItem when an embedding hierarchy is established.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when CarbonLib 1.0 or later is installed. Exported by CarbonLib 1.0 and later and by CarbonLib 1.0 and later.

© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)